8f0826b5e6840773372ce70f56a7c02410dc2843
7 * ^--- tell jenkins this test needs the database
10 * ^--- tell phpunit that these test cases may take longer than 2 seconds.
12 class EditPageTest
extends MediaWikiLangTestCase
{
14 protected function setUp() {
15 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
19 $this->setMwGlobals( [
20 'wgExtraNamespaces' => $wgExtraNamespaces,
21 'wgNamespaceContentModels' => $wgNamespaceContentModels,
22 'wgContentHandlers' => $wgContentHandlers,
23 'wgContLang' => $wgContLang,
26 $wgExtraNamespaces[12312] = 'Dummy';
27 $wgExtraNamespaces[12313] = 'Dummy_talk';
29 $wgNamespaceContentModels[12312] = "testing";
30 $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
32 MWNamespace
::clearCaches();
33 $wgContLang->resetNamespaces(); # reset namespace cache
36 protected function tearDown() {
39 MWNamespace
::clearCaches();
40 $wgContLang->resetNamespaces(); # reset namespace cache
45 * @dataProvider provideExtractSectionTitle
46 * @covers EditPage::extractSectionTitle
48 public function testExtractSectionTitle( $section, $title ) {
49 $extracted = EditPage
::extractSectionTitle( $section );
50 $this->assertEquals( $title, $extracted );
53 public static function provideExtractSectionTitle() {
56 "== Test ==\n\nJust a test section.",
60 "An initial section, no header.",
64 "An initial section with a fake heder (T34617)\n\n== Test == ??\nwtf",
68 "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
72 "== Section== \t\r\n followed by whitespace (T37051)",
78 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
79 $dbw = wfGetDB( DB_MASTER
);
81 $dbw->update( 'revision',
82 [ 'rev_timestamp' => $dbw->timestamp( $timestamp ) ],
83 [ 'rev_id' => $page->getLatest() ] );
89 * User input text is passed to rtrim() by edit page. This is a simple
90 * wrapper around assertEquals() which calls rrtrim() to normalize the
91 * expected and actual texts.
92 * @param string $expected
93 * @param string $actual
96 protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
97 $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
101 * Performs an edit and checks the result.
103 * @param string|Title $title The title of the page to edit
104 * @param string|null $baseText Some text to create the page with before attempting the edit.
105 * @param User|string|null $user The user to perform the edit as.
106 * @param array $edit An array of request parameters used to define the edit to perform.
107 * Some well known fields are:
108 * * wpTextbox1: the text to submit
109 * * wpSummary: the edit summary
110 * * wpEditToken: the edit token (will be inserted if not provided)
111 * * wpEdittime: timestamp of the edit's base revision (will be inserted
113 * * wpStarttime: timestamp when the edit started (will be inserted if not provided)
114 * * wpSectionTitle: the section to edit
115 * * wpMinorEdit: mark as minor edit
116 * * wpWatchthis: whether to watch the page
117 * @param int|null $expectedCode The expected result code (EditPage::AS_XXX constants).
118 * Set to null to skip the check.
119 * @param string|null $expectedText The text expected to be on the page after the edit.
120 * Set to null to skip the check.
121 * @param string|null $message An optional message to show along with any error message.
123 * @return WikiPage The page that was just edited, useful for getting the edit's rev_id, etc.
125 protected function assertEdit( $title, $baseText, $user = null, array $edit,
126 $expectedCode = null, $expectedText = null, $message = null
128 if ( is_string( $title ) ) {
129 $ns = $this->getDefaultWikitextNS();
130 $title = Title
::newFromText( $title, $ns );
132 $this->assertNotNull( $title );
134 if ( is_string( $user ) ) {
135 $user = User
::newFromName( $user );
137 if ( $user->getId() === 0 ) {
138 $user->addToDatabase();
142 $page = WikiPage
::factory( $title );
144 if ( $baseText !== null ) {
145 $content = ContentHandler
::makeContent( $baseText, $title );
146 $page->doEditContent( $content, "base text for test" );
147 $this->forceRevisionDate( $page, '20120101000000' );
151 $currentText = ContentHandler
::getContentText( $page->getContent() );
153 # EditPage rtrim() the user input, so we alter our expected text
155 $this->assertEditedTextEquals( $baseText, $currentText );
158 if ( $user == null ) {
159 $user = $GLOBALS['wgUser'];
161 $this->setMwGlobals( 'wgUser', $user );
164 if ( !isset( $edit['wpEditToken'] ) ) {
165 $edit['wpEditToken'] = $user->getEditToken();
168 if ( !isset( $edit['wpEdittime'] ) ) {
169 $edit['wpEdittime'] = $page->exists() ?
$page->getTimestamp() : '';
172 if ( !isset( $edit['wpStarttime'] ) ) {
173 $edit['wpStarttime'] = wfTimestampNow();
176 if ( !isset( $edit['wpUnicodeCheck'] ) ) {
177 $edit['wpUnicodeCheck'] = EditPage
::UNICODE_CHECK
;
180 $req = new FauxRequest( $edit, true ); // session ??
182 $article = new Article( $title );
183 $article->getContext()->setTitle( $title );
184 $ep = new EditPage( $article );
185 $ep->setContextTitle( $title );
186 $ep->importFormData( $req );
188 $bot = isset( $edit['bot'] ) ?
(bool)$edit['bot'] : false;
190 // this is where the edit happens!
191 // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
192 // and throws exceptions like PermissionsError
193 $status = $ep->internalAttemptSave( $result, $bot );
195 if ( $expectedCode !== null ) {
197 $this->assertEquals( $expectedCode, $status->value
,
198 "Expected result code mismatch. $message" );
201 $page = WikiPage
::factory( $title );
203 if ( $expectedText !== null ) {
204 // check resulting page text
205 $content = $page->getContent();
206 $text = ContentHandler
::getContentText( $content );
208 # EditPage rtrim() the user input, so we alter our expected text
210 $this->assertEditedTextEquals( $expectedText, $text,
211 "Expected article text mismatch. $message" );
217 public static function provideCreatePages() {
219 [ 'expected article being created',
220 'EditPageTest_testCreatePage',
223 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
226 [ 'expected article not being created if empty',
227 'EditPageTest_testCreatePage',
230 EditPage
::AS_BLANK_ARTICLE
,
233 [ 'expected MediaWiki: page being created',
237 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
240 [ 'expected not-registered MediaWiki: page not being created if empty',
241 'MediaWiki:EditPageTest_testCreatePage',
244 EditPage
::AS_BLANK_ARTICLE
,
247 [ 'expected registered MediaWiki: page being created even if empty',
251 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
254 [ 'expected registered MediaWiki: page whose default content is empty'
255 . ' not being created if empty',
256 'MediaWiki:Ipb-default-expiry',
259 EditPage
::AS_BLANK_ARTICLE
,
262 [ 'expected MediaWiki: page not being created if text equals default message',
266 EditPage
::AS_BLANK_ARTICLE
,
269 [ 'expected empty article being created',
270 'EditPageTest_testCreatePage',
273 EditPage
::AS_SUCCESS_NEW_ARTICLE
,
281 * @dataProvider provideCreatePages
284 public function testCreatePage(
285 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
289 $this->setMwGlobals( 'wgHooks', [
290 'PageContentInsertComplete' => [ function (
291 WikiPage
&$page, User
&$user, Content
$content,
292 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
294 // types/refs checked
296 'PageContentSaveComplete' => [ function (
297 WikiPage
&$page, User
&$user, Content
$content,
298 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
299 Status
&$status, $baseRevId
300 ) use ( &$checkId ) {
301 $checkId = $status->value
['revision']->getId();
302 // types/refs checked
306 $edit = [ 'wpTextbox1' => $editText ];
307 if ( $ignoreBlank ) {
308 $edit['wpIgnoreBlankArticle'] = 1;
311 $page = $this->assertEdit( $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
313 if ( $expectedCode != EditPage
::AS_BLANK_ARTICLE
) {
314 $latest = $page->getLatest();
315 $page->doDeleteArticleReal( $pageTitle );
317 $this->assertGreaterThan( 0, $latest, "Page revision ID updated in object" );
318 $this->assertEquals( $latest, $checkId, "Revision in Status for hook" );
323 * @dataProvider provideCreatePages
326 public function testCreatePageTrx(
327 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
330 $this->setMwGlobals( 'wgHooks', [
331 'PageContentInsertComplete' => [ function (
332 WikiPage
&$page, User
&$user, Content
$content,
333 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
335 // types/refs checked
337 'PageContentSaveComplete' => [ function (
338 WikiPage
&$page, User
&$user, Content
$content,
339 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
340 Status
&$status, $baseRevId
341 ) use ( &$checkIds ) {
342 $checkIds[] = $status->value
['revision']->getId();
343 // types/refs checked
347 wfGetDB( DB_MASTER
)->begin( __METHOD__
);
349 $edit = [ 'wpTextbox1' => $editText ];
350 if ( $ignoreBlank ) {
351 $edit['wpIgnoreBlankArticle'] = 1;
354 $page = $this->assertEdit(
355 $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
357 $pageTitle2 = (string)$pageTitle . '/x';
358 $page2 = $this->assertEdit(
359 $pageTitle2, null, $user, $edit, $expectedCode, $expectedText, $desc );
361 wfGetDB( DB_MASTER
)->commit( __METHOD__
);
363 $this->assertEquals( 0, DeferredUpdates
::pendingUpdatesCount(), 'No deferred updates' );
365 if ( $expectedCode != EditPage
::AS_BLANK_ARTICLE
) {
366 $latest = $page->getLatest();
367 $page->doDeleteArticleReal( $pageTitle );
369 $this->assertGreaterThan( 0, $latest, "Page #1 revision ID updated in object" );
370 $this->assertEquals( $latest, $checkIds[0], "Revision #1 in Status for hook" );
372 $latest2 = $page2->getLatest();
373 $page2->doDeleteArticleReal( $pageTitle2 );
375 $this->assertGreaterThan( 0, $latest2, "Page #2 revision ID updated in object" );
376 $this->assertEquals( $latest2, $checkIds[1], "Revision #2 in Status for hook" );
380 public function testUpdatePage() {
383 $this->setMwGlobals( 'wgHooks', [
384 'PageContentInsertComplete' => [ function (
385 WikiPage
&$page, User
&$user, Content
$content,
386 $summary, $minor, $u1, $u2, &$flags, Revision
$revision
388 // types/refs checked
390 'PageContentSaveComplete' => [ function (
391 WikiPage
&$page, User
&$user, Content
$content,
392 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
393 Status
&$status, $baseRevId
394 ) use ( &$checkIds ) {
395 $checkIds[] = $status->value
['revision']->getId();
396 // types/refs checked
402 'wpTextbox1' => $text,
403 'wpSummary' => 'first update',
406 $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
407 EditPage
::AS_SUCCESS_UPDATE
, $text,
408 "expected successfull update with given text" );
409 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
411 $this->forceRevisionDate( $page, '20120101000000' );
415 'wpTextbox1' => $text,
416 'wpSummary' => 'second update',
419 $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
420 EditPage
::AS_SUCCESS_UPDATE
, $text,
421 "expected successfull update with given text" );
422 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
423 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
426 public function testUpdatePageTrx() {
429 'wpTextbox1' => $text,
430 'wpSummary' => 'first update',
433 $page = $this->assertEdit( 'EditPageTest_testTrxUpdatePage', "zero", null, $edit,
434 EditPage
::AS_SUCCESS_UPDATE
, $text,
435 "expected successfull update with given text" );
437 $this->forceRevisionDate( $page, '20120101000000' );
440 $this->setMwGlobals( 'wgHooks', [
441 'PageContentSaveComplete' => [ function (
442 WikiPage
&$page, User
&$user, Content
$content,
443 $summary, $minor, $u1, $u2, &$flags, Revision
$revision,
444 Status
&$status, $baseRevId
445 ) use ( &$checkIds ) {
446 $checkIds[] = $status->value
['revision']->getId();
447 // types/refs checked
451 wfGetDB( DB_MASTER
)->begin( __METHOD__
);
455 'wpTextbox1' => $text,
456 'wpSummary' => 'second update',
459 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
460 EditPage
::AS_SUCCESS_UPDATE
, $text,
461 "expected successfull update with given text" );
465 'wpTextbox1' => $text,
466 'wpSummary' => 'third update',
469 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
470 EditPage
::AS_SUCCESS_UPDATE
, $text,
471 "expected successfull update with given text" );
473 wfGetDB( DB_MASTER
)->commit( __METHOD__
);
475 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
476 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
477 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
480 public static function provideSectionEdit() {
490 $sectionOne = '== one ==
494 $newSection = '== new section ==
499 $textWithNewSectionOne = preg_replace(
500 '/== one ==.*== two ==/ms',
501 "$sectionOne\n== two ==", $text
504 $textWithNewSectionAdded = "$text\n$newSection";
519 'replace first section',
520 $textWithNewSectionOne,
528 $textWithNewSectionAdded,
534 * @dataProvider provideSectionEdit
537 public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
539 'wpTextbox1' => $text,
540 'wpSummary' => $summary,
541 'wpSection' => $section,
544 $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
545 EditPage
::AS_SUCCESS_UPDATE
, $expected,
546 "expected successfull update of section" );
549 public static function provideAutoMerge() {
552 $tests[] = [ # 0: plain conflict
553 "Elmo", # base edit user
554 "one\n\ntwo\n\nthree\n",
557 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
561 'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
563 EditPage
::AS_CONFLICT_DETECTED
, # expected code
564 "ONE\n\ntwo\n\nthree\n", # expected text
565 'expected edit conflict', # message
568 $tests[] = [ # 1: successful merge
569 "Elmo", # base edit user
570 "one\n\ntwo\n\nthree\n",
573 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
577 'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
579 EditPage
::AS_SUCCESS_UPDATE
, # expected code
580 "ONE\n\ntwo\n\nTHREE\n", # expected text
581 'expected automatic merge', # message
585 $text .= "== first section ==\n\n";
586 $text .= "one\n\ntwo\n\nthree\n\n";
587 $text .= "== second section ==\n\n";
588 $text .= "four\n\nfive\n\nsix\n\n";
590 // extract the first section.
591 $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
593 // generate expected text after merge
594 $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
596 $tests[] = [ # 2: merge in section
597 "Elmo", # base edit user
601 'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
606 'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
609 EditPage
::AS_SUCCESS_UPDATE
, # expected code
610 $expected, # expected text
611 'expected automatic section merge', # message
614 // see whether it makes a difference who did the base edit
615 $testsWithAdam = array_map( function ( $test ) {
616 $test[0] = 'Adam'; // change base edit user
620 $testsWithBerta = array_map( function ( $test ) {
621 $test[0] = 'Berta'; // change base edit user
625 return array_merge( $tests, $testsWithAdam, $testsWithBerta );
629 * @dataProvider provideAutoMerge
632 public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
633 $expectedCode, $expectedText, $message = null
635 $this->markTestSkippedIfNoDiff3();
638 $ns = $this->getDefaultWikitextNS();
639 $title = Title
::newFromText( 'EditPageTest_testAutoMerge', $ns );
640 $page = WikiPage
::factory( $title );
642 if ( $page->exists() ) {
643 $page->doDeleteArticle( "clean slate for testing" );
647 'wpTextbox1' => $text,
650 $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
651 $baseUser, $baseEdit, null, null, __METHOD__
);
653 $this->forceRevisionDate( $page, '20120101000000' );
655 $edittime = $page->getTimestamp();
657 // start timestamps for conflict detection
658 if ( !isset( $adamsEdit['wpStarttime'] ) ) {
659 $adamsEdit['wpStarttime'] = 1;
662 if ( !isset( $bertasEdit['wpStarttime'] ) ) {
663 $bertasEdit['wpStarttime'] = 2;
666 $starttime = wfTimestampNow();
667 $adamsTime = wfTimestamp(
669 (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$adamsEdit['wpStarttime']
671 $bertasTime = wfTimestamp(
673 (int)wfTimestamp( TS_UNIX
, $starttime ) +
(int)$bertasEdit['wpStarttime']
676 $adamsEdit['wpStarttime'] = $adamsTime;
677 $bertasEdit['wpStarttime'] = $bertasTime;
679 $adamsEdit['wpSummary'] = 'Adam\'s edit';
680 $bertasEdit['wpSummary'] = 'Bertas\'s edit';
682 $adamsEdit['wpEdittime'] = $edittime;
683 $bertasEdit['wpEdittime'] = $edittime;
686 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
687 EditPage
::AS_SUCCESS_UPDATE
, null, "expected successfull update" );
690 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
691 $expectedCode, $expectedText, $message );
695 * @depends testAutoMerge
697 public function testCheckDirectEditingDisallowed_forNonTextContent() {
698 $title = Title
::newFromText( 'Dummy:NonTextPageForEditPage' );
699 $page = WikiPage
::factory( $title );
701 $article = new Article( $title );
702 $article->getContext()->setTitle( $title );
703 $ep = new EditPage( $article );
704 $ep->setContextTitle( $title );
706 $user = $GLOBALS['wgUser'];
709 'wpTextbox1' => serialize( 'non-text content' ),
710 'wpEditToken' => $user->getEditToken(),
712 'wpStarttime' => wfTimestampNow(),
713 'wpUnicodeCheck' => EditPage
::UNICODE_CHECK
,
716 $req = new FauxRequest( $edit, true );
717 $ep->importFormData( $req );
719 $this->setExpectedException(
721 'This content model is not supported: testing'
724 $ep->internalAttemptSave( $result, false );